<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Debug</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class Debug</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This class provides some debugging functions</p>
		<p class="notes">
			Located in <a class="field" href="_kernel---debug.php.html">/kernel/debug.php</a> (line <span class="field">22</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
												<div class="method-definition">
					static 						<span class="method-result">void</span>
										<a href="#args" title="details" class="method-name">args</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">&$args</span>)
									</div>
																<div class="method-definition">
					static 						<span class="method-result">void</span>
										<a href="#dump" title="details" class="method-name">dump</a>
											(<span class="var-type">array</span>&nbsp;<span class="var-name">$array</span>, [<span class="var-type">name</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">''</span>])
									</div>
																<div class="method-definition">
					static 						<span class="method-result">string</span>
										<a href="#getMicrotime" title="details" class="method-name">getMicrotime</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$start</span>)
									</div>
																<div class="method-definition">
					static 						<span class="method-result">string</span>
										<a href="#message" title="details" class="method-name">message</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>)
									</div>
																<div class="method-definition">
					static 						<span class="method-result">string</span>
										<a href="#profile" title="details" class="method-name">profile</a>
											([<span class="var-type">integer</span>&nbsp;<span class="var-name">$startTime</span> = <span class="var-default">false</span>])
									</div>
																<div class="method-definition">
					static 						<span class="method-result">string</span>
										<a href="#register" title="details" class="method-name">register</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$function</span>)
									</div>
								
																																																				</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodargs" id="args"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method args</span> (line <span class="line-number">56</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Prints out the arguments from a function</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">void</span>
		<span class="method-name">
			args
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">&$args</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">&$args</span><span class="var-description">: argument array from a function</span>			</li>
				</ul>
		
			
	</div>
<a name="methoddump" id="dump"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method dump</span> (line <span class="line-number">33</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Pretty prints an array</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">void</span>
		<span class="method-name">
			dump
		</span>
					(<span class="var-type">array</span>&nbsp;<span class="var-name">$array</span>, [<span class="var-type">name</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">''</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$array</span><span class="var-description">: The array to dump to screen</span>			</li>
					<li>
				<span class="var-type">name</span>
				<span class="var-name">$name</span><span class="var-description">: Optional pretty name to print</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetMicrotime" id="getMicrotime"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method getMicrotime</span> (line <span class="line-number">165</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns current time in seconds</p>
	<ul class="tags">
				<li><span class="field">return:</span> elapsed time</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">string</span>
		<span class="method-name">
			getMicrotime
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$start</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$start</span><span class="var-description">: microtime</span>			</li>
				</ul>
		
			
	</div>
<a name="methodmessage" id="message"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method message</span> (line <span class="line-number">149</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Logs a generic debug message</p>
<p class="description"><p>This function accepts a message that can be used to debug  or trace script flow. Depending on the setting of</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> elapsed time</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">string</span>
		<span class="method-name">
			message
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$message</span><span class="var-description">: message to log/print</span>			</li>
				</ul>
		
			
	</div>
<a name="methodprofile" id="profile"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method profile</span> (line <span class="line-number">180</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Calculates elapsed time</p>
	<ul class="tags">
				<li><span class="field">return:</span> elapsed time</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">string</span>
		<span class="method-name">
			profile
		</span>
					([<span class="var-type">integer</span>&nbsp;<span class="var-name">$startTime</span> = <span class="var-default">false</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">$startTime</span><span class="var-description">: start time to use. If none supplied, script start time is used</span>			</li>
				</ul>
		
			
	</div>
<a name="methodregister" id="register"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method register</span> (line <span class="line-number">94</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Registers current active module</p>
<p class="description"><p>This function is used to register the name of the current  active module/function in order to help trace debugging and profiling.  $type determines the type of message:  'in' - sets function entry  'out' - sets function exit - prints elapsed time</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> elapsed time</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">string</span>
		<span class="method-name">
			register
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$function</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$type</span><span class="var-description">: type of registration</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$function</span><span class="var-description">: module name</span>			</li>
				</ul>
		
			
	</div>

						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Thu, 02 Aug 2007 17:35:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
	</p>
	</div></body>
</html>